Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(bash-completion): prevent space after profile completion . #405

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

myii
Copy link

@myii myii commented Sep 29, 2024

When tab completing a profile, an unwanted space is added after the period ., necessitating hitting backspace before further completions can be accessed.

The implementation here was based on the following resources:

An alternative to checking for the last character is using regex:

Copy link

coderabbitai bot commented Sep 29, 2024

Walkthrough

The changes involve modifications to the Bash completion function for resticprofile. A new conditional check is introduced to determine if the last character of the COMPREPLY array is a period. If not, the compopt +o nospace command is executed, enabling the insertion of a space after completion suggestions. Additionally, the completion registration for resticprofile is updated to directly include the -o nospace option, ensuring consistent completion behaviour.

Changes

Files Change Summary
contrib/completion/bash-completion.sh Updated _resticprofile function to add a conditional check for a period at the end of COMPREPLY and modified the complete command to include -o nospace.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Shell
    participant _resticprofile

    User->>Shell: Request completion for resticprofile
    Shell->>_resticprofile: Call _resticprofile function
    _resticprofile->>_resticprofile: Check last character of COMPREPLY
    alt Last character is not a period
        _resticprofile->>Shell: Execute compopt +o nospace
    end
    _resticprofile->>Shell: Return completion suggestions
    Shell->>User: Display completion suggestions
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f47f408 and cc68b18.

📒 Files selected for processing (1)
  • contrib/completion/bash-completion.sh (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • contrib/completion/bash-completion.sh

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 4181d9e and f47f408.

📒 Files selected for processing (1)
  • contrib/completion/bash-completion.sh (1 hunks)
🧰 Additional context used
🪛 Shellcheck
contrib/completion/bash-completion.sh

[error] 65-65: Arrays implicitly concatenate in [[ ]]. Use a loop (or explicit * instead of @).

(SC2199)

🔇 Additional comments (1)
contrib/completion/bash-completion.sh (1)

72-72: Appropriate update to the completion registration.

The addition of the -o nospace option to the completion registration is a good complement to the new conditional logic. This ensures that spaces are not automatically added after completions by default, allowing the new logic to control space insertion more precisely.

contrib/completion/bash-completion.sh Outdated Show resolved Hide resolved
When tab completing a profile, an unwanted space is added after the
period `.`, necessitating hitting backspace before further completions
can be accessed.

The implementation here was based on the following resources:

* https://stackoverflow.com/a/66151065
  - Add spaces to the end of some Bash autocomplete options,
    but not to others?
* https://stackoverflow.com/a/19271994
  - How can I check the last character in a string in bash?

An alternative to checking for the last character is using regex:

* https://stackoverflow.com/a/21425089
  - How to check if the last string character equals '*' in Bash?
@myii myii force-pushed the feat/prevent-space-after-profile-bash-completion branch from f47f408 to cc68b18 Compare September 29, 2024 14:14
Copy link

codecov bot commented Sep 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.30%. Comparing base (4181d9e) to head (cc68b18).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #405   +/-   ##
=======================================
  Coverage   72.30%   72.30%           
=======================================
  Files         127      127           
  Lines       12940    12940           
=======================================
  Hits         9356     9356           
  Misses       3158     3158           
  Partials      426      426           
Flag Coverage Δ
unittests 72.30% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant